package com.mybatisflex.annotation;

import java.lang.annotation.*;

/**
 * 字典注解
 *
 * @author zhang
 */
@Inherited
@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.FIELD})
public @interface Dictionary {

    /**
     * 字典主码
     *
     * @return 字典主码
     */
    String mainCd();

    /**
     * 字典关联字段名
     * 未指定时，框架将尝试根据如下规则寻找：
     * 字典字段  字典关联字段
     * xxx      xxxName
     * xxxCd    xxxName
     *
     * @return 字典关联字段名
     * @see com.mybatisflex.core.table.TableInfoFactory#initDictionaryColumnInfo
     */
    String dictRelationFiled() default "";
}
